home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 85 / CD Actual 85 Febrero 2004.iso / Experto / Apache / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F252715_mod_disk_cache.xml < prev    next >
Encoding:
Extensible Markup Language  |  2003-04-15  |  10.2 KB  |  330 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <modulesynopsis metafile="mod_disk_cache.xml.meta">
  5.  
  6. <name>mod_disk_cache</name>
  7. <description>Content cache storage manager keyed to URIs</description>
  8. <status>Experimental</status>
  9. <sourcefile>mod_disk_cache.c</sourcefile>
  10. <identifier>disk_cache_module</identifier>
  11.  
  12. <summary>
  13.     <note type="warning">
  14.       This module is experimental. Documentation is still under development...
  15.     </note>
  16.  
  17.     <p><module>mod_disk_cache</module> implements a disk based storage
  18.     manager. It is primarily of use in conjunction with
  19.     <module>mod_proxy</module>.</p>
  20.  
  21.     <p>Content is stored in and retrieved from the cache using URI based
  22.     keys. Content with access protection is not cached.</p>
  23.  
  24.     <note><title>Note:</title>
  25.       <p><module>mod_disk_cache</module> requires the services of
  26.       <module>mod_cache</module>.</p>
  27.     </note>
  28. </summary>
  29.  
  30. <directivesynopsis>
  31. <name>CacheRoot</name>
  32. <description>The directory root under which cache files are
  33. stored</description>
  34. <syntax>CacheRoot <var>directory</var></syntax>
  35. <contextlist><context>server config</context><context>virtual host</context>
  36. </contextlist>
  37.  
  38. <usage>
  39.     <p>The <directive>CacheRoot</directive> directive defines the name of
  40.     the directory on the disk to contain cache files. If the <module
  41.     >mod_disk_cache</module> module has been loaded or compiled in to the
  42.     Apache server, this directive <em>must</em> be defined. Failing to
  43.     provide a value for <directive>CacheRoot</directive> will result in
  44.     a configuration file processing error. The <directive
  45.     module="mod_disk_cache">CacheDirLevels</directive> and <directive
  46.     module="mod_disk_cache">CacheDirLength</directive> directives define
  47.     the structure of the directories under the specified root directory.</p>
  48.  
  49.     <example>
  50.       CacheRoot c:/cacheroot
  51.     </example>
  52. </usage>
  53. </directivesynopsis>
  54.  
  55. <directivesynopsis>
  56. <name>CacheSize</name>
  57. <description>The maximum amount of disk space that will be used by the
  58. cache in KBytes</description>
  59. <syntax>CacheSize <var>KBytes</var></syntax>
  60. <default>CacheSize 1000000</default>
  61. <contextlist><context>server config</context><context>virtual host</context>
  62. </contextlist>
  63.  
  64. <usage>
  65.     <p>The <directive>CacheSize</directive> directive sets the desired
  66.     disk space usage of the cache, in KBytes (1024-byte units). This
  67.     directive does not put a  hard limit on the size of the cache. The
  68.     garbage collector will delete files until the usage is at or below the
  69.     settings. Always use a value that is lower than the available disk
  70.     space.</p>
  71.  
  72.     <example>
  73.       CacheSize  5000000
  74.     </example>
  75. </usage>
  76. </directivesynopsis>
  77.  
  78. <directivesynopsis>
  79. <name>CacheGcInterval</name>
  80. <description>The interval between garbage collection attempts.</description>
  81. <syntax>CacheGcInterval <var>hours</var></syntax>
  82. <contextlist><context>server config</context><context>virtual host</context>
  83. </contextlist>
  84.  
  85. <usage>
  86.     <p>The <directive>CacheGcInterval</directive> directive specifies the
  87.     number of hours to wait between attempts to free up disk space.</p>
  88.     <p>More detail will be added here, when the function is implemented.</p>
  89.  
  90.     <example>
  91.       CacheGcInterval  24<br />
  92.     </example>
  93.  
  94.     <note type="warning">
  95.       The <directive>CacheGcInterval</directive> directive is currently
  96.       <em>not</em> implemented.
  97.     </note>
  98. </usage>
  99. </directivesynopsis>
  100.  
  101. <directivesynopsis>
  102. <name>CacheDirLevels</name>
  103. <description>The number of levels of subdirectories in the
  104. cache.</description>
  105. <syntax>CacheDirLevels <var>levels</var></syntax>
  106. <default>CacheDirLevels 3</default>
  107. <contextlist><context>server config</context><context>virtual host</context>
  108. </contextlist>
  109.  
  110. <usage>
  111.     <p>The <directive>CacheDirLevels</directive> directive sets the number
  112.     of subdirectory levels in the cache. Cached data will be saved this
  113.     many directory levels below the <directive module="mod_disk_cache"
  114.     >CacheRoot</directive> directory.</p>
  115.  
  116.     <note>
  117.       <p>The result of <directive>CacheDirLevels</directive>*
  118.       <directive module="mod_disk_cache">CacheDirLength</directive> must
  119.       not be higher than 20.</p>
  120.     </note>
  121.  
  122.     <example>
  123.       CacheDirLevels  5
  124.     </example>
  125. </usage>
  126. </directivesynopsis>
  127.  
  128. <directivesynopsis>
  129. <name>CacheDirLength</name>
  130. <description>The number of characters in subdirectory names</description>
  131. <syntax>CacheDirLength <var>length</var></syntax>
  132. <default>CacheDirLength 2</default>
  133. <contextlist><context>server config</context><context>virtual host</context>
  134. </contextlist>
  135.  
  136. <usage>
  137.     <p>The <directive>CacheDirLength</directive> directive sets the number
  138.     of characters for each subdirectory name in the cache hierarchy.</p>
  139.  
  140.     <note>
  141.       <p>The result of <directive module="mod_disk_cache"
  142.       >CacheDirLevels</directive>* <directive>CacheDirLength</directive>
  143.       must not be higher than 20.</p>
  144.     </note>
  145.  
  146.     <example>
  147.       CacheDirLength  4
  148.     </example>
  149. </usage>
  150. </directivesynopsis>
  151.  
  152. <directivesynopsis>
  153. <name>CacheExpiryCheck</name>
  154. <description>Indicates if the cache observes Expires dates when seeking
  155. files</description>
  156. <syntax>CacheExpiryCheck On|Off</syntax>
  157. <default>CacheExpiryCheck On</default>
  158. <contextlist><context>server config</context><context>virtual host</context>
  159. </contextlist>
  160.  
  161. <usage>
  162.     <p>More detail will be added here, when the function is implemented.</p>
  163.  
  164.     <example>
  165.       CacheExpiryCheck Off<br />
  166.     </example>
  167.  
  168.     <note type="warning">
  169.       The <directive>CacheExpiryCheck</directive> directive is currently
  170.       <em>not</em> implemented.
  171.     </note>
  172. </usage>
  173. </directivesynopsis>
  174.  
  175. <directivesynopsis>
  176. <name>CacheMinFileSize</name>
  177. <description>The minimum size (in bytes) of a document to be placed in the
  178. cache</description>
  179. <syntax>CacheMinFileSize <var>bytes</var></syntax>
  180. <default>CacheMinFileSize 1</default>
  181. <contextlist><context>server config</context><context>virtual host</context>
  182. </contextlist>
  183.  
  184. <usage>
  185.     <p>The <directive>CacheMinFileSize</directive> directive sets the
  186.     minimum size, in bytes, for a document to be considered for storage
  187.     in the cache.</p>
  188.  
  189.     <example>
  190.       CacheMinFileSize 64
  191.     </example>
  192. </usage>
  193. </directivesynopsis>
  194.  
  195. <directivesynopsis>
  196. <name>CacheMaxFileSize</name>
  197. <description>The maximum size (in bytes) of a document to be placed in the
  198. cache</description>
  199. <syntax>CacheMaxFileSize <var>bytes</var></syntax>
  200. <default>CacheMaxFileSize 1000000</default>
  201. <contextlist><context>server config</context><context>virtual host</context>
  202. </contextlist>
  203.  
  204. <usage>
  205.     <p>The <directive>CacheMaxFileSize</directive> directive sets the
  206.     maximum size, in bytes, for a document to be considered for storage in
  207.     the cache.</p>
  208.  
  209.     <example>
  210.       CacheMaxFileSize 64000
  211.     </example>
  212. </usage>
  213. </directivesynopsis>
  214.  
  215. <directivesynopsis>
  216. <name>CacheTimeMargin</name>
  217. <description>The minimum time margin to cache a document</description>
  218. <syntax>CacheTimeMargin <var>?</var></syntax>
  219. <default>CacheTimeMargin ?</default>
  220. <contextlist><context>server config</context><context>virtual host</context>
  221. </contextlist>
  222.  
  223. <usage>
  224.     <p>More detail will be added here, when the function is implemented.</p>
  225.  
  226.     <example>
  227.       CacheTimeMargin X
  228.     </example>
  229.  
  230.     <note type="warning">
  231.       The <directive>CacheTimeMargin</directive> directive is currently
  232.       <em>not</em> implemented.
  233.     </note>
  234. </usage>
  235. </directivesynopsis>
  236.  
  237. <directivesynopsis>
  238. <name>CacheGcDaily</name>
  239. <description>The recurring time each day for garbage collection to be run.
  240. (24 hour clock)</description>
  241. <syntax>CacheGcDaily <var>time</var></syntax>
  242. <default>CacheGcDaily ?</default>
  243. <contextlist><context>server config</context><context>virtual host</context>
  244. </contextlist>
  245.  
  246. <usage>
  247.     <p>More detail will be added here, when the function is implemented.</p>
  248.  
  249.     <example>
  250.       CacheGcDaily 23:59
  251.     </example>
  252.  
  253.     <note type="warning">
  254.       The <directive>CacheGcDaily</directive> directive is currently
  255.       <em>not</em> implemented.
  256.     </note>
  257. </usage>
  258. </directivesynopsis>
  259.  
  260. <directivesynopsis>
  261. <name>CacheGcUnused</name>
  262. <description>The time to retain unreferenced cached files that match a
  263. URL.</description>
  264. <syntax>CacheGcUnused <var>hours</var> <var>url-string</var></syntax>
  265. <default>CacheGcUnused ?</default>
  266. <contextlist><context>server config</context><context>virtual host</context>
  267. </contextlist>
  268.  
  269. <usage>
  270.     <p>More detail will be added here, when the function is implemented.</p>
  271.  
  272.     <example>
  273.       CacheGcUnused 12 /local_images
  274.     </example>
  275.  
  276.     <note type="warning">
  277.       The <directive>CacheGcUnused</directive> directive is currently
  278.       <em>not</em> implemented.
  279.     </note>
  280. </usage>
  281. </directivesynopsis>
  282.  
  283. <directivesynopsis>
  284. <name>CacheGcClean</name>
  285. <description>The time to retain unchanged cached files that match a
  286. URL</description>
  287. <syntax>CacheGcClean <var>hours</var> <var>url-string</var></syntax>
  288. <default>CacheGcClean ?</default>
  289. <contextlist><context>server config</context><context>virtual host</context>
  290. </contextlist>
  291.  
  292. <usage>
  293.     <p>More detail will be added here, when the function is implemented.</p>
  294.  
  295.     <example>
  296.       CacheGcClean 12 /daily_scripts
  297.     </example>
  298.  
  299.     <note type="warning">
  300.       The <directive>CacheGcClean</directive> directive is currently
  301.       <em>not</em> implemented.
  302.     </note>
  303. </usage>
  304. </directivesynopsis>
  305.  
  306. <directivesynopsis>
  307. <name>CacheGcMemUsage</name>
  308. <description>The maximum kilobytes of memory used for garbage
  309. collection</description>
  310. <syntax>CacheGcMemUsage <var>KBytes</var></syntax>
  311. <default>CacheGcMemUsage ?</default>
  312. <contextlist><context>server config</context><context>virtual host</context>
  313. </contextlist>
  314.  
  315. <usage>
  316.     <p>More detail will be added here, when the function is implemented.</p>
  317.  
  318.     <example>
  319.       CacheGcMemUsage 16
  320.     </example>
  321.  
  322.     <note type="warning">
  323.       The <directive>CacheGcMemUsage</directive> directive is currently
  324.       <em>not</em> implemented.
  325.     </note>
  326. </usage>
  327. </directivesynopsis>
  328.  
  329. </modulesynopsis>
  330.